home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / label.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  7.4 KB  |  292 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/label.man,v 1.11 92/05/29 13:46:42 ouster Exp $ SPRITE (Berkeley)
  11. '/" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS label cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. label \- Create and manipulate label widgets
  193. .SH SYNOPSIS
  194. \fBlabel\fI \fIpathName \fR?\fIoptions\fR?
  195. .SH "STANDARD OPTIONS"
  196. .LP
  197. .nf
  198. .ta 4c 8c 12c
  199. .VS
  200. \fBanchor    \fBborderWidth\fR    \fBforeground\fR    \fBrelief\fR
  201. \fBbackground\fR    \fBcursor\fR    \fBpadX\fR    \fBtext\fR
  202. \fBbitmap\fR    \fBfont\fR    \fBpadY\fR    \fBtextVariable\fR
  203. .VE
  204. .fi
  205. .LP
  206. See the ``options'' manual entry for details on the standard options.
  207. .SH "WIDGET-SPECIFIC OPTIONS"
  208. .LP
  209. .nf
  210. .VS
  211. Name:    \fBheight\fR
  212. Class:    \fBHeight\fR
  213. Command-Line Switch:    \fB\-height\fR
  214. .fi
  215. .IP
  216. Specifies a desired height for the label.
  217. If a bitmap is being displayed in the label then the value is in
  218. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  219. for text it is in lines of text.
  220. If this option isn't specified, the label's desired height is computed
  221. from the size of the bitmap or text being displayed in it.
  222. .LP
  223. .nf
  224. Name:    \fBwidth\fR
  225. Class:    \fBWidth\fR
  226. Command-Line Switch:    \fB\-width\fR
  227. .fi
  228. .IP
  229. Specifies a desired width for the label.
  230. If a bitmap is being displayed in the label then the value is in
  231. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  232. for text it is in characters.
  233. If this option isn't specified, the label's desired width is computed
  234. from the size of the bitmap or text being displayed in it.
  235. .VE
  236. .BE
  237.  
  238. .SH DESCRIPTION
  239. .PP
  240. The \fBlabel\fR command creates a new window (given by the
  241. \fIpathName\fR argument) and makes it into a label widget.
  242. Additional
  243. options, described above, may be specified on the command line
  244. or in the option database
  245. to configure aspects of the label such as its colors, font,
  246. text, and initial relief.  The \fBlabel\fR command returns its
  247. \fIpathName\fR argument.  At the time this command is invoked,
  248. there must not exist a window named \fIpathName\fR, but
  249. \fIpathName\fR's parent must exist.
  250. .PP
  251. A label is a widget
  252. .VS
  253. that displays a textual string or bitmap.
  254. .VE
  255. The label can be manipulated in a few simple ways, such as
  256. changing its relief or text, using the commands described below.
  257.  
  258. .SH "WIDGET COMMAND"
  259. .PP
  260. The \fBlabel\fR command creates a new Tcl command whose
  261. name is \fIpathName\fR.  This
  262. command may be used to invoke various
  263. operations on the widget.  It has the following general form:
  264. .DS C
  265. \fIpathName option \fR?\fIarg arg ...\fR?
  266. .DE
  267. \fIOption\fR and the \fIarg\fRs
  268. determine the exact behavior of the command.  The following
  269. commands are possible for label widgets:
  270. .TP
  271. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  272. Query or modify the configuration options of the widget.
  273. If no \fIoption\fR is specified, returns a list describing all of
  274. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  275. information on the format of this list).  If \fIoption\fR is specified
  276. with no \fIvalue\fR, then the command returns a list describing the
  277. one named option (this list will be identical to the corresponding
  278. sublist of the value returned if no \fIoption\fR is specified).  If
  279. one or more \fIoption\-value\fR pairs are specified, then the command
  280. modifies the given widget option(s) to have the given value(s);  in
  281. this case the command returns an empty string.
  282. \fIOption\fR may have any of the values accepted by the \fBlabel\fR
  283. command.
  284.  
  285. .SH BINDINGS
  286. .PP
  287. When a new label is created, it has no default event bindings:
  288. labels are not intended to be interactive.
  289.  
  290. .SH KEYWORDS
  291. label, widget
  292.